Publier une fiche Rzine
Processus de rédaction, soumission et relecture d’une fiche Rzine
1 Une fiche Rzine
1.1 Qu’est-ce c’est ?
La “fiche” est une publication didactique qui présente une méthodologie, un type d’analyse, une fonctionnalité, ou encore le traitement d’un certain type de données avec le langage R. Une fiche peut être principalement technique, méthodologique ou thématique ; elle peut également couvrir ces trois aspects. Elle est évaluée par au moins deux personnes ayant les connaissances thématiques nécessaires.
Le premier objectif d’une fiche consiste à partager de manière pédagogique des méthodes reproductibles applicables en SHS. La publication d’une fiche est ouverte à toutes et tous, quels que soient son statut et sa discipline. Une fiche peut être réalisée à plusieurs et présenter une dimension interdisciplinaire.
Les auteurs et autrices sont libres dans le choix de la problématique et dans la façon d’articuler le contenu. Il est cependant indispensable que le contenu soit correctement contextualisé et intelligible pour l’ensemble des disciplines de SHS. Il est également obligatoire de suivre les règles suivantes :
- utiliser le modèle de mise en page
readrzine, - rédiger en français ou en anglais,
- introduire et contextualiser le contenu,
- présenter du code entièrement reproductible,
- utiliser des données libres d’utilisation et mises à disposition des lecteurs et lectrices,
- fournir les fichiers et annexes demandées.
Vous pouvez consulter les premières fiches déjà produites pour vous faire une idée du résultat attendu :
- Analyse
territoriale multiscalaire, Ronan Ysebaert et Claude
Grasland.
- Analyse
des corrélations avec easystats, Grégoire Le Campion.
- Exploration spatio-temporelle d’objets géographiques ponctuels, Marion Le Texier.
- Réaliser une carte de discontinuités en 2,5D, Nicolas Lambert.
Rzine souhaite promouvoir et partager des usages et pratiques de logiciels et méthodes contribuant à une science plus ouverte et reproductible, et participer à une montée en compétence des disciplines de SHS dans ce domaine. C’est pour cela que l’ensemble du processus d’évaluation se déroule sur GitHub qui repose sur le logiciel de gestion de versions Git. Cela ne doit en aucun cas effrayer les auteurs et autrices qui n’ont jamais utilisé Git : de la documentation et une assistance sont fournies par le comité de lecture Rzine… !
1.2 Critères d’acceptation
Afin d’assurer la cohérence et la qualité du contenu des fiches Rzine, plusieurs critères d’acceptation ont été définis. Certains de ces critères peuvent conduire au refus immédiat d’une proposition de fiche par le comité de lecture, d’autres critères font l’objet d’une analyse contradictoire par plusieurs évaluateur·rice·s.
Les éditeur·rice·s et les évaluateur·rice·s veilleront à ce que :
- la démonstration soit contextualisée (champ disciplinaire d’application) et rigoureuse,
- le code présenté se doit d’être lisible, commenté et reproductible,
- les packages mobilisés doivent être brièvement décrits et leur utilisation justifiée,
- les données ou jeux de données utilisés dans le cadre de la démonstration doivent obligatoirement être publiés, sourcés et librement réutilisables.
| Editeur·rice·s | Evaluateur·rice·s | |
|---|---|---|
| Respect des consignes éditoriales (partie 3) | X | |
| Acceptation des futures conditions d’utilisation (partie 4) | X | |
| Pas de fiche Rzine similaire déjà produite* | X | |
| N’a pas fait l’objet d’une publication par ailleurs | X | |
| Pas de renvoi publicitaire explicite | X | X |
| Respect du règlement général sur la protection des données (RGPD) | X | X |
| Intérêt pour la communauté des utilisateurices de R en SHS | X | X |
| Données et jeux de données utilisés publiés, sourcés et librement réutilisables (partie 3.4) | X | X |
| Rédaction dans un français ou un anglais correct | X | |
| Méthodes applicables en SHS | X | |
| Contextualisation de l’analyse ou méthode présentée (partie 3.3) | X | |
| Présentation des prérequis techniques et méthodologiques | X | |
| Clarté et rigueur de la ressource et de la démonstration | X | |
| Clarté (indentation, commentaire…) et reproductibilité du code présenté | X | X |
| Justification (et stabilité) des packages utilisés | X | X |
*Le cas échéant, le comité de lecture se réserve la possibilité de
mettre en relation différent·es contributeurices pour leur proposer un
travail collaboratif.
1.3 Soumission et évaluation
1.4 Publication et licence d’utilisation
Les choix des dépôts et licences d’utilisation s’inscrivent dans la volonté du projet Rzine de promouvoir des pratiques contribuant à une science plus ouverte et à la reproductibilité des méthodes. L’ensemble des publications de la collection Rzine avec leurs codes sources est automatiquement référencé et mis à disposition de toutes et tous. Afin d’éviter tout malentendu avec les auteurices, un accord de principe est demandé en amont du processus éditorial.
Etre auteurice d’une fiche Rzine, c’est accepter que :
votre publication (HTML) soit mise à disposition sous les conditions d’utilisation de la licence Creative Commons BY-SA 4.0,
les données et jeux de données associés ont été ou sont rendus publics, sont sourcés et leur réutilisation est libre,
son code source réponde aux conditions d’utilisation de la licence MIT.
2 Forme et modèle de
fiche : le package rzine
Une fiche Rzine est un document computationnel, alternant texte et code, permettant d’appliquer le paradigme de la programmation lettrée. Sa transcription en HTML nécessite :
- les packages
rmarkdownetknitrpour la transformation du document Rmd, - et le package
rzinequi fournit le modèle de document numérique (Pédauque, Salaün 2006) associé à une fiche rzine. Il comprend un ensemble de fichiers et une structure de répertoires correspondant à un package R. Il permet de déployer sur votre ordinateur, en syntaxe Rmarkdown, le modèle éditorialreadrzined’un notebook R qui sera publié au format statique HTML.
2.1 Installation du
package rzine
Le package est mis à disposition sur un dépôt du groupe Rzine sur l’instance GitLab de la TGIR Huma-num. Pour l’installer et le charger il suffit de copier le code ci-dessous dans votre console R :
install.packages("remotes") # si le package `remotes` n'est pas encore installé
remotes::install_gitlab("rzine/package", host = "https://gitlab.huma-num.fr/", force = TRUE)
library(rzine)2.2 Utiliser le
template readrzine
2.2.1 Première étape : spécifier un répertoire de travail
Avant de générer une fiche Rzine vierge il est important de spécifier un répertoire de travail. Pour cela, deux solutions s’offrent à vous :
1. En clic-bouton avec Rstudio (recommandé)
Pour créer un projet Rstudio, cliquez sur File/New Project, sélectionnez New Directory, puis New Project :2. En ligne de code R
Créez un répertoire sur votre ordinateur puis spécifiez-le comme
répertoire de travail avec la fonction setwd() dans votre
console :
setwd("/home/jeanne/Documents/Fiche_rzine")2.2.2 Seconde étape : générer une première fiche vide (index.Rmd)
Dans votre projet Rstudio (ou bien au sein du répertoire de travail
que vous avez spécifié), vous pouvez générer un modèle de fiche
readrzine vide en ligne de commande.
Copiez-collez les
lignes de code R suivantes dans votre console sans les
modifier, puis exécutez-les :
rmarkdown::draft(file = "index.Rmd",
template = "readrzine",
package = "rzine",
create_dir = FALSE,
edit = FALSE)Un ensemble de fichiers est généré à la racine du répertoire de
travail que vous avez créé. Certains fichiers seront à modifier ou à
ajouter en fonction du contenu de votre fiche.
La figure
ci-dessous donne la description de la structure et des fichiers créés au
sein de votre répertoire de travail :
2.2.3 Troisième étape : “kniter” la fiche (index.html)
Pour générer la fiche en HTML, il suffit de “kniter” (tricoter) le fichier index.Rmd.
Bien que cela soit invisible pour l’utilisateurice, le fichier est d’abord converti en syntaxe Markdown puis en HTML via le logiciel libre de conversion de documents Pandoc.Vous pouvez “kniter” le fichier index.Rmd de différentes manières :
1. Avec Rstudio (recommandé)
2. En ligne de code R
rmarkdown::render("index.Rmd", envir = new.env())
Un fichier du même nom en format HTML est alors créé à
la racine de votre répertoire : index.html. Il s’agit du
fichier index.Rmd transformé en HTML statique à partir du modèle
readrzine :
Il ne reste plus qu’à le remplir…
- en modifiant, pas-à-pas, votre fichier index.Rmd (voir la partie 3. ci-dessous),
- puis, en le “knitant” pour visualiser la version HTML de votre fiche
(dans un émulateur Rstudio ou dans votre navigateur).
3 La rédaction d’une fiche
3.1 Métadonnées d’en tête
Commencez par modifier l’en-tête du template
readrzine (YAML header), en personnalisant
le titre, le sous-titre, le nom de ou
des auteur.es et les affiliations,
comme par exemple :
---
title: "Analyse textuelle exploratoire"
subtitle: "Exploration d'un corpus de lettre avec le package Quanteda"
date: "2023-10-09"
author:
- name: Jeanne Dupont
affiliation: UMR TEXTO, CNRS
- name: Paul Edouard
affiliation: Centre documentaire ED, Université de France
3.2 Le résumé
Il est obligatoire de proposer un résumé en début de publication. Ce résumé sera utilisé pour la page de présentation de la fiche sur le site rzine.fr, pour le dépôt Github du code source (cf. exemple), du DOI et le référencement sur HAL.
Ce résumé doit faire entre 250 à 800 caractères (espaces comprises). Il peut comprendre des informations sur d’éventuels prérequis pour bien comprendre le document.
Pour mettre en forme votre résumé en introduction de fiche, utilisez le symbol “>” qui permet de créer un bloc de citation qui apparaîtra sur un fond gris. Exemple :
> Ce document... xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx
> **Prérequis** : xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx
Le bloc de citation apparaîtra comme suit :
Ce document… xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx
Prérequis : xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx
3.3 Contextualisation
Il est essentiel et obligatoire d’introduire et de contextualiser le contenu de votre document.
Vous pouvez pour cela vous appuyer sur des références bibliographiques, utiles pour les non-spécialistes de la thématique ou de la méthode présentée.
3.4 Données utilisées
3.4.1 Conditions d’utilisation
Pour assurer le reproductibilité complète de la fiche, les données utilisées doivent obligatoirement être mises à disposition des lecteur·rice·s. Pour ne pas empêcher la diffusion publique et libre de la fiche, vous ne pouvez pas utiliser de données soumises à des restrictions de diffusion et d’utilisation publiques.
3.4.2 Présentation
Les données doivent être directement présentées, sourcées et brièvement décrites dans la fiche (cf.exemple). Consacrez-y un chapitre ou sous-chapitre en fonction de leurs spécificités.
3.4.3 Mise à disposition
Même si les données mobilisées sont déjà librement mises à disposition, il est obligatoire de les sauvegarder dans votre répertoire et de les rendre directement téléchargeables depuis la fiche.
Pour cela :
Copiez votre (ou vos) fichier(s) de données dans le sous-répertoire “data”.
Remplissez le fichier metadata.md (Markdown) situé à la racine, avec toutes les métadonnées nécessaires et obligatoires. Ce fichier doit contenir toutes les informations utiles pour comprendre et retrouver ces données à la source.
Ajoutez un bouton de téléchargement des données dans votre fiche, en copiant-collant ce bout de code HTML :
<br/>
<p class="center">[<span style="font-size: 230%;" class="glyphicon glyphicon-download-alt"></span><br/>Télécharger les données](https://rzine.fr/docs/...../data.zip)</p>
<br/>
Voici le rendu :
C’est ensuite aux éditeur·rice·s de rendre ce lien opérationnel
durant le processus de publication.
3.5 Packages et fonctions
Comme pour les données, il est important de consacrer un
sous-chapitre aux packages utilisés. Tous les packages mobilisés
pour l’analyse doivent être listés et décrits :
- package1 : description…
- package2 : description…
- package3 : description…
Tous les packages et fonctions explicitement nommés doivent également être mis en page de cette façon :
`packages` et `fonction()`
Voici le rendu : packages et fonction()
3.6 Illustration
3.6.1 Illustration de couverture
Le template readrzine permet l’affichage d’une
illustration en couverture.
Le format optimal de cette image de couverture est de type “bandeau” (ex : 750 x 300 pixels).
3.6.2 Image dans le corps du texte
Les images affichées dans le corps du texte doivent être stockées dans le répertoire “figures”. Il existe plusieurs solutions pour insérer des images dans un document R Markdown. Il est possible d’utiliser du code R dans un chunk, d’utiliser le langage Markdown ou HTML (recommandé).
Pour insérer une image en HTML :
<figure class="center">
<img src="figures/rzine.png" width="200">
<figcaption style="font-size:13px;">Logo de la collection Rzine, 2021, [https://rzine.fr/collection/#collection](https://rzine.fr/collection/#collection){target="_blank"}</figcaption>
</figure>
Cela affichera l’image centrée et large de 200 pixels, ainsi qu’un titre (source) :
3.7 Ecriture de code R
Le code R présenté dans la fiche doit être indenté, espacé et commenté. Il est demandé aux auteur·e·s de prendre soin de la syntaxe et de respecter les principales conventions d’écriture.
Pour en savoir plus, vous pouvez consulter The tidyverse style guide d’Hadley Wickham.
3.8 Message d’alerte
Il est possible d’utiliser certains messages d’alerte boostrap :
- Encadré vert (success) : pour mettre en avant une
information
- Encadré rouge (danger) : our mettre en relief une information primordiale
La syntaxe HTML à utiliser est :
<div class="alert alert-success" role="alert">Message d'information</div>
**ET**
<div class="alert alert-danger" role="alert">Message <b>très important</b></div>
Voici le rendu :
ET
3.9 Formules mathématiques
Il est possible d’écrire des formules mathématiques en langage \(\TeX\). Il suffit de délimiter le contenu \(\LaTeX\) par un ou deux symboles $, ex :
$$ y = \sqrt{\frac{1}{x + \beta}} $$
En mode Inline (un seul $)
, les formules sont incluses à l’intérieur du paragraphe courant, ex :
\(\sum_{i=1}^n X_i\)
En mode Displayed (deux $),
elles apparaissent centrées et mises en exergue, ex : \[ y = \sqrt{\frac{1}{x + \beta}} \]
3.10 Références bibliographiques
Le template readrzine intègre automatiquement une
section de références bibliographiques. Il est fortement recommandé aux
auteur·e·s de l’utiliser. Cependant cette section n’est pas obligatoire,
vous pouvez supprimer les lignes suivantes dans le fichier
index.rmd si vous ne souhaitez pas afficher de bibliographie
:
# Bibliographie {-}
<div id="refs"></div>
Sinon, pour ajouter des références bibliographiques, complétez le fichier biblio.bib.
Trois références bibliographiques sont saisies par défaut dans le fichier biblio.bib :
@Manual{R-base,
title = {R: A Language and Environment for Statistical Computing},
author = {{R Core Team}},
organization = {R Foundation for Statistical Computing},
address = {Vienna, Austria},
year = {2020},
url = {https://www.R-project.org/},
}
@Manual{R-knitr,
title = {knitr: A General-Purpose Package for Dynamic Report Generation in R},
author = {Yihui Xie},
year = {2020},
note = {R package version 1.28},
url = {https://CRAN.R-project.org/package=knitr},
}
@Manual{R-rmdformats,
title = {rmdformats: HTML Output Formats and Templates for 'rmarkdown' Documents},
author = {Julien Barnier},
year = {2021},
note = {R package version 1.0.2},
url = {https://github.com/juba/rmdformats},
}
Beaucoup de documentation sur les fichiers BibTex sont consultables
sur internet (exemple).
Pour citer une référence dans le corps du texte, utilisez la syntaxe
suivante : [@Citation Key]. Citation Key = nom de la
référence dans le fichier BibTex (ex : R_base, R-knitr ou R-rmdformats).
Par exemple, la chaîne de caractère [@R-base] affichera le
lien (R Core Team 2020) dans le document.
Toutes les références bibliographiques renseignées dans le fichier
biblio.bib seront automatiquement ajoutées dans la section « Bibliographie ».
3.11 Glossaire
Cette section n’est pas obligatoire, cependant vos lecteur.rices ne seront pas forcément issu·es de votre discipline ou ne maîtriseront peut-être pas la thématique ou méthode présentée. En définissant certains termes utilisés, la section « Glossaire » permet de rendre la démonstration compréhensible à un public plus large.
Pour ajouter un mot ou expression, ainsi que sa définition dans le Glossaire, utilisez la syntaxe markdown suivante :
texte texte texte mot à définir^[__Mot à définir__: Définition du terme... ]
A la compilation du document en format HTML, un numéro est automatiquement associé et affiché après le “mot à définir”. Ce mot/expression et sa définition sont ajoutés dans la section « Glossaire ». Exemple : Mot à définir1
Si vous ne souhaitez pas utiliser de Glossaire, supprimez les lignes suivantes dans le fichier index.rmd :
## Glossaire {- #endnotes}
```{js, echo=FALSE}
$(document).ready(function() {
$('.footnotes ol').appendTo('#endnotes');
$('.footnotes').remove();
});3.12 Informations sur la session
Cette section obligatoire est directement intégrée au template.
## Info session {-}
```{r session_info, echo=FALSE}
kableExtra::kable_styling(knitr::kable(rzine::sessionRzine()[[1]], row.names = F))
kableExtra::kable_styling(knitr::kable(rzine::sessionRzine()[[2]], row.names = F))
```
Ce bout de code affiche des informations sur la session qui a permis de générer la fiche (système d’exploitation, versions de R et des packages utilisés). Voir l’exemple pour ce document.
3.13 Citation BibTex
Cette section obligatoire est directement intégrée au template.
## Citation {-}
```{r Citation, echo=FALSE}
rref <- bibentry(
bibtype = "article",
title = "Titre de la fiche",
author = person("Auteur.e 1", "Auteur.e 2" ),
journal = "Rzine.fr",
publisher = "FR CIST",
year = 2021,
url = "https://...")
```
`r capture.output(print(rref))`
### BibTex : {-}
```{r generateBibTex, echo=FALSE}
writeLines(toBibtex(rref), "cite.bib")
toBibtex(rref)
```
<br/>
Ne mofifiez pas cette section, elle sera complétée avant publication par l’équipe éditoriale. Ces deux chunks permettent l’affichage de la référence bibliographique de votre fiche dans le corps du document (Voir l’exemple pour ce document), ainsi que le stockage de cette référence en format BibTex, enregistrée dans le fichier cite.bib à la racine du répertoire.
4 La soumission d’une fiche
Une fois que le fichier index.Rmd est rédigé et qu’il a été compilé en format HTML (knit), vérifiez que les annexes (biblio.bib, featured.png, figures et data) ont été complétées, remplacées ou supprimées.
Vous êtes alors en mesure de soumettre votre travail au comité de lecture Rzine. Pour cela, vous devez :
1) Déposer votre travail sur un dépôt Git.
2) Déployer la fiche en format HTML depuis le dépôt
GitHub pour la rendre consultable en ligne.
3) Contacter le comité de lecture en lui fournissant
l’adresse du dépôt.
4.1 Premiers pas sur Github
Le logiciel de gestion de versions décentralisé que vous devez utiliser pour la soumission est GitHub.
4.1.1 Création de compte
Commencez par vous connecter à la page de création de compte GitHub.
Saisissez le courriel que vous souhaitez utiliser, un mot de passe, un nom d’utilisateur et répondez aux questions de sécurité pour créer votre compte. Un code de sécurité vous sera envoyé au courriel renseigné afin de valider la création du compte.
4.1.2 Création d’un dépôt
Vous avez désormais un compte GitHub. Cliquez sur “Start a project” ou “Create repository” pour créer un dépôt qui hébergera votre fiche.
Vous pouvez également créer un nouveau dépôt en cliquant sur “+” puis “New repository” en haut à droite de la fenêtre :
Un fois sur la page de création d’un nouveau dépôt, saisissez un nom de dépôt (sans espaces ni caractères spéciaux) et éventuellement une description. Initialisez ce dépôt comme Public et demandez l’ajout automatique d’un fichier README.md :
Puis cliquez sur “Create repository”. Votre dépôt, uniquement rempli d’un fichier README.md, a été créé :
4.2 Remplissage du dépôt
Vous pouvez désormais y ajouter le répertoire (et sous-répertoires) contenant tous les fichiers de votre fiche. Il existe plusieurs méthodes pour téléverser des fichiers sur GitHub (en ligne de commande ou en clic-bouton). Nous présentons ici la méthode clic-bouton depuis l’interface de GitHub.
Cliquez sur “Add file”, puis sur “Upload files” :.
Ajoutez un commentaire et cliquez sur “Commit changes” :
Vous venez de réaliser votre premier “commit” (enregistrement des changements). L’ensemble des fichiers est désormais stocké sur le dépôt :
Ce dépôt étant paramétré comme public, tout le monde peut désormais le consulter et récupérer les fichiers qu’il contient.
4.3 Déploiement de la fiche
Les fichiers sont consultables à l’état brut, mais une manipulation supplémentaire va permettre de mettre en ligne votre fiche (format HTML). Votre fiche mise en forme sera ainsi consultable par tout le monde sur le web, sans avoir à gérer un serveur ou un site web.
4.3.1 GitHub Page
Dans le dépôt concerné, cliquez sur “Settings > Pages > Source (none)” et sélectionnez la branche “main” :
Ne modifiez pas le répertoire ciblé par défaut (”root”) et cliquez sur “save” :
Votre fiche est désormais consultable en ligne depuis votre compte GitHub !
La page html est alors distribuée à l’adresse suivante : https://username.gitub.io/repository_name.Vous pouvez retrouver l’URL d’accès dans le menu “Settings > Pages” :
Cliquez sur le lien affiché pour consulter la fiche mise en ligne :
4.3.2 README.md
Le fichier markdown README.md est utilisé pour présenter les informations importantes à propos du dépôt. Son contenu est automatiquement affiché (et mis en forme grâce à la syntaxe markdown) sous les fichiers listés du dépôt.
Vous pouvez éditer et modifier facilement ce fichier depuis l’interface GitHub en cliquant sur le symbole crayon :
Vous pouvez alors personnaliser le fichier en modifiant : le titre, le sous-titre, le.s auteur.e.s (et affiliation.s), et l’URL de consultation de la fiche. Exemple :
Une fois les modifications terminées, commentez votre commit, puis cliquez sur Commit changes pour enregistrer les modifications :
4.4 Soumettre
Il ne vous reste plus qu’à contacter le comité de lecture Rzine pour soumettre votre fiche pour évaluation. Envoyez un courriel à collection[a]rzine.fr, en précisant l’adresse du dépôt qui héberge votre fiche.
Vous serez contacté·e par le comité de lecture dans les 15 jours suivants l’envoi de ce courriel.
5 Le processus de relecture
En cas d’acceptation, un ou une éditeur·rice désigné·e par la direction du comité de lecture prendra sous sa responsabilité le du processus de relecture.
Deux relecteur·rice·s doté·e·s des connaissances thématiques nécessaires seront proposé·e·s à l’auteur·e. Rzine est dans une démarche volontariste de science ouverte, la relecture des fiches Rzine est ouverte et transparente. L’identité des relecteur·rice·s et leurs retours sont publics.
Parce qu’une fiche est un document computationnel, l’ensemble du processus se déroule sur GitHub. Vous serez donc invité·e à ouvrir les droits du dépôt GitHub de votre fiche aux relecteur·rice·s désigné·e·s. Les retours (enrichissements, illustrations, corrections…) se feront se feront directement sur la plateforme GitHub via des issues.
6 Anatomie d’un R Markdown
6.1 L’en-tête
L’en-tête d’un document R Markdown (parfois appelé YAML header) est
délimité par deux lignes de trois tirets et contient des métadonnées et
les éléments de style du document. Voici à quoi ressemble par exemple
l’en-tête vierge du template readrzine
:
---
title: "Titre fiche"
subtitle: "Sous-titre fiche"
date: "2023-10-09"
author:
- name: Premier Auteur.e
affiliation: Affiliation_1, Affiliation_2
- name: Second Auteur.e
affiliation: Affiliation_1, Affiliation_2
image: "featured.png"
logo: "figures/rzine.png"
output:
rzine::readrzine:
highlight: kate
number_sections: true
csl: Rzine_citation.csl
bibliography: biblio.bib
nocite: |
@*
link-citations: true
# github: "author/repository"
# gitlab: "gitlab.huma-num.fr/author/repository"
# doi: "xx.xxx/xxxx.xxxxxxx"
# licence: "by-sa"
# Only Creative Commons Licence
# 5 possible choices : "by-nd", "by", "by-nc-sa", "by-nc","by-sa"
---
6.2 Le texte balisé en markdown
Le corps d’un document R Markdown comprend deux types de contenu, que l’on peut librement alterner :
- Des blocs de texte brut mis en forme selon la
syntaxe Markdown ;
- Des blocs de code, appelés chunks (cf. partie 3.3).
Le corps du document est constitué de texte mis en forme à l’aide de la syntaxe Markdown. Le Markdown est un langage de balisage léger et très facile à maîtriser, qui permet la mise en forme basique du texte.
Par exemple, le texte (brut) suivant :
Ceci est du texte en *italique*, **gras** ou en ***gras italique***.
Pour définir des listes à puces, utilisez les **tirets** :
- premier élément
- second élément
Vous pouvez également ajouter des [liens cliquables](https://rzine.fr/)
Sera mis en page de la manière suivante dans le fichier HTML généré :
Ceci est du texte en italique, gras ou en gras italique.
Pour définir des listes à puces, utilisez les tirets :
- premier élément
- second élément
Vous pouvez également ajouter des liens cliquables
6.3 Les chunks
En plus du texte libre balisé en markdown, un document R Markdown
peut évidemment contenir du code R.
Celui-ci doit être inclus dans des chunks
délimités par la syntaxe suivante :
```{r}
x <- 37 + 12
print(x)
```
Pour insérer facilement un nouveau chunk, vous pouvez utiliser le menu Insert proposé par l’interface de développement RStudio, situé en haut à droite de l’éditeur de texte (à gauche du bouton Run) :
Vous pouvez également utiliser le raccourci clavier
Ctrl + Alt + i ou Command + Option + I pour
générer un chunk vide.
6.3.1 Nom et options
Vous pouvez nommer chaque chunk de la manière suivante :
```{r nom_du_chunck_1}
```
Un nom de chunk doit être unique. Il n’est pas obligatoire de nommer un chunk, mais cela peut être utile pour localiser une erreur lors de la compilation du code.
Des options peuvent être ajoutées sous la forme
option = valeur. Elles permettent de paramétrer le
comportement d’un chunk lors d’un knit (compilation du
document). Exemple :
```{r nom_du_chunck_2, echo = FALSE, warning = FALSE}
x <- 37 + 12
print(x)
```
L’option echo permet d’afficher (ou pas) le code dans le
document généré, et l’option warning permet d’afficher (ou
non) les avertissements générés par le code en sortie. Voici la liste
des principales options disponibles :
| Option | Valeurs | Description |
|---|---|---|
| echo | TRUE/FALSE | Afficher ou non le code R dans le document en sortie |
| eval | TRUE/FALSE | Exécuter ou non le code R durant la compilation du R Markdown |
| include | TRUE/FALSE | Inclure ou non le code R et ses résultats dans le document |
| warning | TRUE/FALSE | Afficher ou non les avertissements générés par le code du chunk |
| message | TRUE/FALSE | Afficher ou non les messages générés par le code du chunk |
L’ensemble des options disponibles sont décrites dans le guide de référence R Markdown, et également dans plusieurs références listées ci-dessous.
6.4 Documentation de référence
Pour en savoir plus, pour se former au R Markdown et à la syntaxe markdown :
- Cookbook R Markdown, de Y. Xie, C. Dervieux & E. Riederer
- R Markdown Definitive Guide, de Y. Xie, J. J. Allaire & G. Grolemund
- R Markdown for Scientists, de Nicholas Tierney
- Introduction à R et au tidyverse, de Julien Barnier
- Travail collaboratif avec R, de Lino Galiana
- Pimp my RMD: a few tips for R Markdown, de Yan Holtz
- R for Data Science, de H. Wickham & G. Groelemund
- Guide de la syntaxe R Markdown, de Rstudio
- Guide de référence R Markdown, de Rstudio
- R Markdown Cheatsheet, de Rstudio
- Writing Reproducible Research Papers with R Markdown, de Resul Umit
7 Question ?
Pour toute question relative au processus de soumission et de relecture d’une fiche, vous pouvez contacter le comité de lecture à l’adresse collection[a]rzine.fr.
Bibliographie
Annexes
Info session
| setting | value |
|---|---|
| version | R version 4.2.0 (2022-04-22) |
| os | macOS Big Sur/Monterey 10.16 |
| system | x86_64, darwin17.0 |
| ui | X11 |
| language | (EN) |
| collate | en_US.UTF-8 |
| ctype | en_US.UTF-8 |
| tz | Europe/Paris |
| date | 2023-10-09 |
| pandoc | 2.19.2 @ /Applications/RStudio.app/Contents/Resources/app/quarto/bin/tools/ (via rmarkdown) |
| package | ondiskversion | source |
|---|---|---|
| kableExtra | 1.3.4 | CRAN (R 4.2.0) |
| knitr | 1.43 | CRAN (R 4.2.0) |
Citation
Rzine (2021). “Publier une fiche Rzine.” doi:10.48645/xxxxxx, https://doi.org/10.48645/xxxxxx,, https://rzine.fr/publication_rzine/xxxxxxx/.
BibTex :
@Misc{,
title = {Publier une fiche Rzine},
subtitle = {Processus de rédaction, soumission et relecture d’une fiche Rzine},
author = {{Rzine}},
doi = {10.48645/xxxxxx},
url = {https://rzine.fr/publication_rzine/xxxxxxx/},
keywords = {FOS: Other social sciences},
language = {fr},
publisher = {FR2007 CIST},
year = {2021},
copyright = {Creative Commons Attribution Share Alike 4.0 International},
}
Glossaire
Mot à définir: Définition du terme à définir… ect.↩︎